Skip to content

Remove test log display from docs and clean up conf.py#283

Open
shegazyy wants to merge 3 commits into
eclipse-score:mainfrom
Valeo-S-CORE-Organization:fix/remove_test_logs_from_docs
Open

Remove test log display from docs and clean up conf.py#283
shegazyy wants to merge 3 commits into
eclipse-score:mainfrom
Valeo-S-CORE-Organization:fix/remove_test_logs_from_docs

Conversation

@shegazyy

@shegazyy shegazyy commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

The DisplayTestLogs Sphinx directive collected bazel-testlogs at build time and embedded them in the verification report. This had two problems:

  • The directive was registered in the local conf.py which is not executed in the score reference integration (docs-as-code), making it a no-op in official releases.
  • The project has decided not to include test logs in documentation.

Remove the directive class, its registration, and the "Test Log Files" section in statistics.rst. Also drop the now-unused docutils imports.

Closes #266

@shegazyy shegazyy temporarily deployed to workflow-approval July 6, 2026 11:12 — with GitHub Actions Inactive
@shegazyy shegazyy temporarily deployed to workflow-approval July 6, 2026 11:12 — with GitHub Actions Inactive
@github-actions

github-actions Bot commented Jul 6, 2026 •
edited
Loading

Copy link
Copy Markdown

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run --lockfile_mode=error //:license-check

Status: ⚠️ Needs Review

Click to expand output 
[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.6.0) and connecting to it...
INFO: Invocation ID: c52a9066-69b7-4481-b8da-55d3f144e91a
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: 
Analyzing: target //:license-check (1 packages loaded)
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)

Analyzing: target //:license-check (44 packages loaded, 10 targets configured)

Analyzing: target //:license-check (87 packages loaded, 10 targets configured)

Analyzing: target //:license-check (151 packages loaded, 5477 targets configured)

Analyzing: target //:license-check (156 packages loaded, 5498 targets configured)

Analyzing: target //:license-check (161 packages loaded, 5543 targets configured)

Analyzing: target //:license-check (164 packages loaded, 7434 targets configured)

Analyzing: target //:license-check (164 packages loaded, 7434 targets configured)

Analyzing: target //:license-check (164 packages loaded, 7434 targets configured)

Analyzing: target //:license-check (164 packages loaded, 7434 targets configured)

Analyzing: target //:license-check (164 packages loaded, 7434 targets configured)

Analyzing: target //:license-check (167 packages loaded, 10275 targets configured)

Analyzing: target //:license-check (168 packages loaded, 10283 targets configured)

Analyzing: target //:license-check (168 packages loaded, 10283 targets configured)

Analyzing: target //:license-check (168 packages loaded, 10283 targets configured)

Analyzing: target //:license-check (168 packages loaded, 10283 targets configured)

Analyzing: target //:license-check (168 packages loaded, 10283 targets configured)

INFO: Analyzed target //:license-check (169 packages loaded, 10409 targets configured).
[10 / 16] Creating runfiles tree bazel-out/k8-opt-exec-ST-d57f47055a04/bin/external/score_tooling+/dash/tool/formatters/dash_format_converter.runfiles [for tool]; 0s local
[12 / 16] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 0s disk-cache, processwrapper-sandbox ... (2 actions running)
[15 / 16] [Sched] Building license.check.license_check.jar ()
INFO: Found 1 target...
Target //:license.check.license_check up-to-date:
  bazel-bin/license.check.license_check
  bazel-bin/license.check.license_check.jar
INFO: Elapsed time: 31.585s, Critical Path: 2.38s
INFO: 16 processes: 12 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 16 total actions
INFO: Running command line: bazel-bin/license.check.license_check ./formatted.txt <args omitted>
usage: org.eclipse.dash.licenses.cli.Main [-batch <int>] [-cd <url>]
       [-confidence <int>] [-ef <url>] [-excludeSources <sources>] [-help] [-lic
       <url>] [-project <shortname>] [-repo <url>] [-review] [-summary <file>]
       [-timeout <seconds>] [-token <token>]

@shegazyy

shegazyy commented Jul 6, 2026

Copy link
Copy Markdown
Contributor Author

Hey @AlexanderLanin 🙏 ready for review whenever you have a moment!

@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown

The created documentation from the pull request is available at: docu-html

@shegazyy
Remove test log display from docs and clean up conf.py
5e0cc09 
The DisplayTestLogs Sphinx directive collected bazel-testlogs at build
time and embedded them in the verification report. This had two problems:
- The directive was registered in the local conf.py which is not executed
  in the score reference integration (docs-as-code), making it a no-op
  in official releases.
- The project has decided not to include test logs in documentation.

Remove the directive class, its registration, and the "Test Log Files"
section in statistics.rst. Also drop the now-unused docutils imports.

Closes eclipse-score#266
@shegazyy shegazyy force-pushed the fix/remove_test_logs_from_docs branch from 79fd187 to 5e0cc09 Compare July 8, 2026 12:34
@shegazyy shegazyy requested a deployment to workflow-approval July 8, 2026 12:34 — with GitHub Actions Waiting
@shegazyy shegazyy requested a deployment to workflow-approval July 8, 2026 12:34 — with GitHub Actions Waiting
@NicolasFussberger

NicolasFussberger commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Hi @shegazyy, thanks for your contribution! Could you please update your branch to latest main, then I will merge it. Thanks!

@shegazyy shegazyy requested a deployment to workflow-approval July 13, 2026 10:50 — with GitHub Actions Waiting
@shegazyy shegazyy requested a deployment to workflow-approval July 13, 2026 10:50 — with GitHub Actions Waiting
@shegazyy

shegazyy commented Jul 13, 2026

Copy link
Copy Markdown
Contributor Author

@NicolasFussberger branch is updated with the latest main 🙏

@shegazyy shegazyy requested a deployment to workflow-approval July 13, 2026 15:34 — with GitHub Actions Waiting
@shegazyy shegazyy requested a deployment to workflow-approval July 13, 2026 15:34 — with GitHub Actions Waiting
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@NicolasFussberger NicolasFussberger NicolasFussberger approved these changes

Assignees

No one assigned

Labels

None yet

Projects

LCM - Lifecycle & Health FT
Status: Backlog

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

docs-as-code mismatch

2 participants

@shegazyy @NicolasFussberger